Day26 - gRPC - Golang

14th鐵人賽

羊羹

2022-10-11 13:22:02

2701 瀏覽

分享至

要學習的東西太多了，最後幾天有點亂掉，今天就來研究gRPC吧。

RPC

RPC是Remote Procedure Calls（遠端程序呼叫）的簡稱。一種遠端遠端調用程式的模組，可以讓遠端程式可以透過網路通訊方法呼叫本地function與method的一種方法。簡單一點的解說，今天有A、B兩台伺服器，A伺服器想要呼叫B伺服器提供的函式，但因為不在同一個空間，不能直接呼叫，透過網路通訊方法模擬直接從本地呼叫的樣式，即為RPC。

概念大概如下：

Client從遠端呼叫一個function
此function的參數會被打包成特定格式的封包
網路傳送封包
Server接收封包
將封包轉換成可執行本地function的參數格式
執行此function後朝client回傳result

目的

提供分散式系統間溝通的方法
隱藏實作方法，與呼叫自己的方法一樣

gRPC

gRPC（Remote Procedure Calls）是Google發起的一個開源的RPC系統。可以更輕鬆地創建分佈式應用程序和服務。

特色

以Protobuf格式傳輸資料
HTTP/2通訊協定，效能好
支援雙向串流
支持多種開發語言

傳輸方式

單向傳輸(Unary)：一個request，一個response，與一般http請求一樣，只是是透過gRPC協定。
單向串流(Streaming)：client發送一個request後，server可以多次response。
雙向串流(Bidirectional streaming)：同WebSocket，傳輸格式透過schema定義，兩邊都可以多次request與reponse。

透過Go使用gRPC

由於版本更新之前網路上相關文章有些使用方法已經不能使用了，目前統整的是我自己能使用的方式。

載入相關套件

protobuf go get -u google.golang.org/protobuf
gRPC go get -u google.golang.org/grpc
protobuf-compiler
照這篇文的內容設置好windows的Protocol Compiler。

在終端機輸入下面兩行，
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest

這樣基本套件應該都載入好了。

撰寫Protobuf檔

在開發之前要先撰寫Protobuf檔，定義資料交換的相關資料，因此建立一個以proto為副檔名的檔案。

syntax = "proto3"; 

option go_package = "./protobuffer";
//定義Service名稱，
service SaySomethingService{ 
  //定義api名稱，傳入參數與回傳值
    rpc TestRPC (testRequest) returns (testResponse) {}
}

//傳入參數的spec
message testRequest {
    int64  id = 1;  
}

//回傳值的spec
message testResponse {
    string  name = 1;
    float   heigh = 2;
    float   weight = 3;
}

在參數後的 = <數字> ;是指輸入與輸出順序。相關方法定義好後，在終端機輸入以下指令

protoc --go_out=. --go-grpc_out=. test.proto

執行後會依照上方option go_package放入兩個.pb.go的檔案，這就是protoc編譯器幫忙使用定義好的proto檔產生的go檔案。

實作server與client端

正常來說兩份檔案應該要指向同一支protobuffer，我這邊偷懶了一下兩邊都編譯出了.pb.go檔

server

package main

import (
	"context"
	"log"
	"net"
	pb "grpc-test/protobuffer"
	"google.golang.org/grpc"
)

const (
	port = ":8080"
)

type server struct{}

func main() {
	// Create gRPC Server
	lis, err := net.Listen("tcp", port)
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}
	s := grpc.NewServer()
	log.Println("gRPC server is running.")
	pb.RegisterSaySomethingServiceServer(s, &server{})
	if err := s.Serve(lis); err != nil {
		log.Fatalf("failed to serve: %v", err)
	}
}

//
func (s *server) TestRPC(ctx context.Context, in *pb.TestRequest) (*pb.TestResponse, error) {
	log.Println("i receive:", in.Id)
	return &pb.TestResponse{Name: "Jay", Weight: 75, Heigh: 170}, nil
}

這邊執行下來&server{}那邊會出錯，貌似是因為interface沒有將所有功能實作完，我有到test_grpc.pb.go中將下面功能做註解。

type SaySomethingServiceServer interface {
	// 定義api名稱，傳入參數與回傳值
	TestRPC(context.Context, *TestRequest) (*TestResponse, error)
    // 註解掉下面這行
	// MustEmbedUnimplementedSaySomethingServiceServer()
}

順利的話應該能執行起來讓伺服器運行。

client

用另一支Go程式模擬客戶端，這邊只是隨意發送一筆int值，讓server端回傳寫好的內容而已，實際運用時這邊可以做function的調用。

package main

import (
	"context"
	pb "grpc-client/protobuffer"
	"log"
	"time"
	"google.golang.org/grpc"
)

const (
	address = "localhost:8080"
)

func main() {

	conn, err := grpc.Dial(address, grpc.WithInsecure(), grpc.WithBlock())
	if err != nil {
		log.Fatalf("did not connect: %v", err)
	}
	defer conn.Close()
	c := pb.NewSaySomethingServiceClient(conn)
	TestRPC(c, 12)

}

//
func TestRPC(c pb.SaySomethingServiceClient, id int64) {

	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
	defer cancel()
	res, err := c.TestRPC(ctx, &pb.TestRequest{Id: id })
	if err != nil {
		log.Fatalf("could not mkdfk2020: %v", err)
	}
	log.Printf("gRPC response: %s", res)
}